<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen; http://apigen.org" />

	<title>Class Nette\Web\User</title>

	<link rel="stylesheet" href="resources/style.css?v=2011071314" type="text/css" media="all" />
	<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
	<link rel="search" href="opensearch.xml" type="application/opensearchdescription+xml" title="Nette Framework API documentation" />
	<script type="text/javascript" src="resources/combined.js"></script>
	<script type="text/javascript" src="allclasses.js"></script>
</head>

<body>
<div id="left">
	<a href="allclasses.html">All Classes</a>

	<h3>Namespaces</h3>
	<ul>
		<li><a href="namespace-none.html">none</a>
		</li>
		<li><a href="namespace-Nette.html">Nette</a>
		</li>
		<li><a href="namespace-Nette.Application.html">Nette\Application</a>
		</li>
		<li><a href="namespace-Nette.Caching.html">Nette\Caching</a>
		</li>
		<li><a href="namespace-Nette.Collections.html">Nette\Collections</a>
		</li>
		<li><a href="namespace-Nette.Config.html">Nette\Config</a>
		</li>
		<li><a href="namespace-Nette.Forms.html">Nette\Forms</a>
		</li>
		<li><a href="namespace-Nette.IO.html">Nette\IO</a>
		</li>
		<li><a href="namespace-Nette.Loaders.html">Nette\Loaders</a>
		</li>
		<li><a href="namespace-Nette.Mail.html">Nette\Mail</a>
		</li>
		<li><a href="namespace-Nette.Reflection.html">Nette\Reflection</a>
		</li>
		<li><a href="namespace-Nette.Security.html">Nette\Security</a>
		</li>
		<li><a href="namespace-Nette.Templates.html">Nette\Templates</a>
		</li>
		<li class="active"><a href="namespace-Nette.Web.html">Nette\Web</a>
		</li>
		<li><a href="namespace-PHP.html">PHP</a>
		</li>
	</ul>

	<hr />

	<h3>Classes</h3>

	<ul>
		<li><a href="Nette.Web.Ftp.html">Ftp</a></li>
		<li><a href="Nette.Web.Html.html">Html</a></li>
		<li><a href="Nette.Web.HttpContext.html">HttpContext</a></li>
		<li><a href="Nette.Web.HttpRequest.html">HttpRequest</a></li>
		<li><a href="Nette.Web.HttpResponse.html">HttpResponse</a></li>
		<li><a href="Nette.Web.HttpUploadedFile.html">HttpUploadedFile</a></li>
		<li><a href="Nette.Web.Session.html">Session</a></li>
		<li><a href="Nette.Web.SessionNamespace.html">SessionNamespace</a></li>
		<li><a href="Nette.Web.Uri.html">Uri</a></li>
		<li><a href="Nette.Web.UriScript.html">UriScript</a></li>
		<li class="active"><a href="Nette.Web.User.html">User</a></li>
	</ul>

	<h3>Interfaces</h3>

	<ul>
		<li><a href="Nette.Web.IHttpRequest.html">IHttpRequest</a></li>
		<li><a href="Nette.Web.IHttpResponse.html">IHttpResponse</a></li>
		<li><a href="Nette.Web.IUser.html">IUser</a></li>
	</ul>

	<h3>Exceptions</h3>

	<ul>
		<li><a href="Nette.Web.FtpException.html">FtpException</a></li>
	</ul>
</div>

<div id="right">
	<form action="http://www.google.com/cse" id="search" onsubmit="if(this.q.value.indexOf('more:')==-1)this.q.value+=' more:api'">
		<input type="hidden" name="cx" value="011549293477758430224:vxofa9ufnhc" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" class="text" /><input type="submit" value="Search" />
	</form>

<div id="navigation">
	<ul>
		<li><a href="overview.html" title="Summary of all namespaces">Overview</a></li>
		<li><a href="namespace-Nette.Web.html" title="Summary of Nette\Web">Namespace</a></li>
		<li class="active">Class</li>
		<li><a href="elements.html">Elements</a></li>
	</ul>
</div>

<div id="content">
	<div id="classSummary">
		<p>namespace <a href="namespace-Nette.Web.html">Nette\Web</a></p>

		<h1>Class User</h1>

		<div class="classDescription">
		
<p>User authentication and authorization.</p>

		</div>

		<dl class="tree">
			<dd style="padding-left:0px">
				<a href="Nette.Object.html">Nette\Object</a>
				
			</dd>
			<dd style="padding-left:30px">
				<img src="resources/inherit.gif" alt="extended by" />
<b>Nette\Web\User</b>				 implements <a href="Nette.Web.IUser.html">IUser</a>
			</dd>
		</dl>



		<div class="classInfo">
			
				<b>Author:</b> David Grudl<br />
			<b>Located at</b> <a href="source-Web.User.php.html#22">/Web/User.php</a><br />
		</div>
	</div>


	<div id="methodSummary">
		<table class="summary">
		<caption>Method Summary</caption>
		<tr data-order="1 __construct" id="___construct">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#___construct">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#73" title="go to source code"><b>__construct</b></a>(
			)</code>

			<div class="short">
				
			</div>

			<div class="detailed">
				





			</div>
			</td>
		</tr>
		<tr data-order="1 login" id="_login">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_login">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#87" title="go to source code"><b>login</b></a>(
					string
					<var>$username</var>, 
					string
					<var>$password</var>, 
					mixed
					<var>$extra</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Conducts the authentication process.</p>

			</div>

			<div class="detailed">
				
<p>Conducts the authentication process.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$username</code> string <br />
						<code>$password</code> string <br />
						<code>$extra</code> mixed <br />
					</div>


					<h4>Throws</h4>
					<div class="smallList">
						<a href="Nette.Security.AuthenticationException.html">Nette\Security\AuthenticationException</a> if authentication was not successful<br />
					</div>

					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_login">IUser::login</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 logout" id="_logout">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_logout">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#117" title="go to source code"><b>logout</b></a>(
					bool
					<var>$clearIdentity</var> = <span class="php-keyword1">false</span>
			)</code>

			<div class="short">
				
<p>Logs out the user from the current session.</p>

			</div>

			<div class="detailed">
				
<p>Logs out the user from the current session.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$clearIdentity</code> bool clear the identity from persistent storage?<br />
					</div>



					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_logout">IUser::logout</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 isLoggedIn" id="_isLoggedIn">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				bool
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_isLoggedIn">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#136" title="go to source code"><b>isLoggedIn</b></a>(
			)</code>

			<div class="short">
				
<p>Is this user authenticated?</p>

			</div>

			<div class="detailed">
				
<p>Is this user authenticated?</p>




					<h4>Returns</h4>
					<div class="smallList">bool </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_isLoggedIn">IUser::isLoggedIn</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 getIdentity" id="_getIdentity">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				<a href="Nette.Security.IIdentity.html">Nette\Security\IIdentity</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getIdentity">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#148" title="go to source code"><b>getIdentity</b></a>(
			)</code>

			<div class="short">
				
<p>Returns current user identity, if any.</p>

			</div>

			<div class="detailed">
				
<p>Returns current user identity, if any.</p>




					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Security.IIdentity.html">Nette\Security\IIdentity</a> </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_getIdentity">IUser::getIdentity</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 setAuthenticationHandler" id="_setAuthenticationHandler">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setAuthenticationHandler">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#160" title="go to source code"><b>setAuthenticationHandler</b></a>(
					<a href="Nette.Security.IAuthenticator.html">Nette\Security\IAuthenticator</a>
					
					<var>$handler</var>
			)</code>

			<div class="short">
				
<p>Sets authentication handler.</p>

			</div>

			<div class="detailed">
				
<p>Sets authentication handler.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$handler</code> <a href="Nette.Security.IAuthenticator.html">Nette\Security\IAuthenticator</a> <br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_setAuthenticationHandler">IUser::setAuthenticationHandler</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 getAuthenticationHandler" id="_getAuthenticationHandler">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				<a href="Nette.Security.IAuthenticator.html">Nette\Security\IAuthenticator</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getAuthenticationHandler">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#173" title="go to source code"><b>getAuthenticationHandler</b></a>(
			)</code>

			<div class="short">
				
<p>Returns authentication handler.</p>

			</div>

			<div class="detailed">
				
<p>Returns authentication handler.</p>




					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Security.IAuthenticator.html">Nette\Security\IAuthenticator</a> </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_getAuthenticationHandler">IUser::getAuthenticationHandler</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 setNamespace" id="_setNamespace">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setNamespace">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#187" title="go to source code"><b>setNamespace</b></a>(
					string
					<var>$namespace</var>
			)</code>

			<div class="short">
				
<p>Changes namespace; allows more users to share a session.</p>

			</div>

			<div class="detailed">
				
<p>Changes namespace; allows more users to share a session.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$namespace</code> string <br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_setNamespace">IUser::setNamespace</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 getNamespace" id="_getNamespace">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				string
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getNamespace">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#203" title="go to source code"><b>getNamespace</b></a>(
			)</code>

			<div class="short">
				
<p>Returns current namespace.</p>

			</div>

			<div class="detailed">
				
<p>Returns current namespace.</p>




					<h4>Returns</h4>
					<div class="smallList">string </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_getNamespace">IUser::getNamespace</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 setExpiration" id="_setExpiration">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setExpiration">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#214" title="go to source code"><b>setExpiration</b></a>(
					string|int|<a href="DateTime.html">DateTime</a>
					<var>$time</var>, 
					bool
					<var>$whenBrowserIsClosed</var> = <span class="php-keyword1">true</span>, 
					bool
					<var>$clearIdentity</var> = <span class="php-keyword1">false</span>
			)</code>

			<div class="short">
				
<p>Enables log out after inactivity.</p>

			</div>

			<div class="detailed">
				
<p>Enables log out after inactivity.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$time</code> string|int|<a href="DateTime.html">DateTime</a> number of seconds or timestamp<br />
						<code>$whenBrowserIsClosed</code> bool log out when the browser is closed?<br />
						<code>$clearIdentity</code> bool clear the identity from persistent storage?<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


			</div>
			</td>
		</tr>
		<tr data-order="1 getLogoutReason" id="_getLogoutReason">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				int
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getLogoutReason">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#242" title="go to source code"><b>getLogoutReason</b></a>(
			)</code>

			<div class="short">
				
<p>Why was user logged out?</p>

			</div>

			<div class="detailed">
				
<p>Why was user logged out?</p>




					<h4>Returns</h4>
					<div class="smallList">int </div>


			</div>
			</td>
		</tr>
		<tr data-order="1 getSessionNamespace" id="_getSessionNamespace">
			<td align="right" width="1%"><code class="nowrap">
				 protected 
				<a href="Nette.Web.SessionNamespace.html">SessionNamespace</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getSessionNamespace">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#254" title="go to source code"><b>getSessionNamespace</b></a>(
					
					<var>$need</var>
			)</code>

			<div class="short">
				
<p>Returns and initializes $this-&gt;session.</p>

			</div>

			<div class="detailed">
				
<p>Returns and initializes $this-&gt;session.</p>




					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.SessionNamespace.html">SessionNamespace</a> </div>


			</div>
			</td>
		</tr>
		<tr data-order="1 setAuthenticated" id="_setAuthenticated">
			<td align="right" width="1%"><code class="nowrap">
				 protected 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setAuthenticated">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#306" title="go to source code"><b>setAuthenticated</b></a>(
					bool
					<var>$state</var>
			)</code>

			<div class="short">
				
<p>Sets the authenticated status of this user.</p>

			</div>

			<div class="detailed">
				
<p>Sets the authenticated status of this user.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$state</code> bool flag indicating the authenticated status of user<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


			</div>
			</td>
		</tr>
		<tr data-order="1 setIdentity" id="_setIdentity">
			<td align="right" width="1%"><code class="nowrap">
				 protected 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setIdentity">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#332" title="go to source code"><b>setIdentity</b></a>(
					<a href="Nette.Security.IIdentity.html">Nette\Security\IIdentity</a>
					
					<var>$identity</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Sets the user identity.</p>

			</div>

			<div class="detailed">
				
<p>Sets the user identity.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$identity</code> IIdentity <br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


			</div>
			</td>
		</tr>
		<tr data-order="1 getRoles" id="_getRoles">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				array
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getRoles">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#349" title="go to source code"><b>getRoles</b></a>(
			)</code>

			<div class="short">
				
<p>Returns a list of effective roles that a user has been granted.</p>

			</div>

			<div class="detailed">
				
<p>Returns a list of effective roles that a user has been granted.</p>




					<h4>Returns</h4>
					<div class="smallList">array </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_getRoles">IUser::getRoles</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 isInRole" id="_isInRole">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				bool
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_isInRole">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#365" title="go to source code"><b>isInRole</b></a>(
					string
					<var>$role</var>
			)</code>

			<div class="short">
				
<p>Is a user in the specified effective role?</p>

			</div>

			<div class="detailed">
				
<p>Is a user in the specified effective role?</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$role</code> string <br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">bool </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_isInRole">IUser::isInRole</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 isAllowed" id="_isAllowed">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				bool
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_isAllowed">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#377" title="go to source code"><b>isAllowed</b></a>(
					string
					<var>$resource</var> = <span class="php-keyword1">NULL</span>, 
					string
					<var>$privilege</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Has a user effective access to the Resource?</p>

			</div>

			<div class="detailed">
				
<p>Has a user effective access to the Resource?<br>
If $resource is NULL, then the query applies to all resources.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$resource</code> string resource<br />
						<code>$privilege</code> string privilege<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">bool </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_isAllowed">IUser::isAllowed</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 setAuthorizationHandler" id="_setAuthorizationHandler">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				<a href="Nette.Web.User.html">User</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_setAuthorizationHandler">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#400" title="go to source code"><b>setAuthorizationHandler</b></a>(
					<a href="Nette.Security.IAuthorizator.html">Nette\Security\IAuthorizator</a>
					
					<var>$handler</var>
			)</code>

			<div class="short">
				
<p>Sets authorization handler.</p>

			</div>

			<div class="detailed">
				
<p>Sets authorization handler.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$handler</code> <a href="Nette.Security.IAuthorizator.html">Nette\Security\IAuthorizator</a> <br />
					</div>

					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.User.html">User</a> provides a fluent interface</div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_setAuthorizationHandler">IUser::setAuthorizationHandler</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 getAuthorizationHandler" id="_getAuthorizationHandler">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				<a href="Nette.Security.IAuthorizator.html">Nette\Security\IAuthorizator</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getAuthorizationHandler">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#413" title="go to source code"><b>getAuthorizationHandler</b></a>(
			)</code>

			<div class="short">
				
<p>Returns current authorization handler.</p>

			</div>

			<div class="detailed">
				
<p>Returns current authorization handler.</p>




					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Security.IAuthorizator.html">Nette\Security\IAuthorizator</a> </div>


					<h4>Implementation of</h4>
					<div class="smallList"><code><a href="Nette.Web.IUser.html#_getAuthorizationHandler">IUser::getAuthorizationHandler</a></code></div>
			</div>
			</td>
		</tr>
		<tr data-order="1 getSession" id="_getSession">
			<td align="right" width="1%"><code class="nowrap">
				 protected 
				<a href="Nette.Web.Session.html">Session</a>
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getSession">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#431" title="go to source code"><b>getSession</b></a>(
			)</code>

			<div class="short">
				
<p>Returns session handler.</p>

			</div>

			<div class="detailed">
				
<p>Returns session handler.</p>




					<h4>Returns</h4>
					<div class="smallList"><a href="Nette.Web.Session.html">Session</a> </div>


			</div>
			</td>
		</tr>
		<tr data-order="1 authenticate" id="_authenticate">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_authenticate">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#442" title="go to source code"><b>authenticate</b></a>(
					
					<var>$username</var>, 
					
					<var>$password</var>, 
					
					<var>$extra</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
			</div>

			<div class="detailed">
				





			</div>
			</td>
		</tr>
		<tr data-order="1 signOut" id="_signOut">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_signOut">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#448" title="go to source code"><b>signOut</b></a>(
					
					<var>$clearIdentity</var> = <span class="php-keyword1">false</span>
			)</code>

			<div class="short">
				
			</div>

			<div class="detailed">
				





			</div>
			</td>
		</tr>
		<tr data-order="1 isAuthenticated" id="_isAuthenticated">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_isAuthenticated">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#454" title="go to source code"><b>isAuthenticated</b></a>(
			)</code>

			<div class="short">
				
			</div>

			<div class="detailed">
				





			</div>
			</td>
		</tr>
		<tr data-order="1 getSignOutReason" id="_getSignOutReason">
			<td align="right" width="1%"><code class="nowrap">
				 public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_getSignOutReason">#</a>
			<code class="nowrap">
				<a href="source-Web.User.php.html#460" title="go to source code"><b>getSignOutReason</b></a>(
			)</code>

			<div class="short">
				
			</div>

			<div class="detailed">
				





			</div>
			</td>
		</tr>

		</table>
	</div>


	<h2>Methods Inherited From <a href="Nette.Object.html#methodSummary">Nette\Object</a></h2>
	<div class="box"><code>
		<a href="Nette.Object.html#_getClass" class="deprecated">getClass()</a>, <a href="Nette.Object.html#_getReflection">getReflection()</a>, <a href="Nette.Object.html#___call">__call()</a>, <a href="Nette.Object.html#___callStatic">__callStatic()</a>, <a href="Nette.Object.html#_extensionMethod">extensionMethod()</a>, <a href="Nette.Object.html#___get">__get()</a>, <a href="Nette.Object.html#___set">__set()</a>, <a href="Nette.Object.html#___isset">__isset()</a>, <a href="Nette.Object.html#___unset">__unset()</a>
	</code></div>


	<div id="constantSummary">
		<table class="summary">
		<caption>Constant Summary</caption>
		<tr data-order="MANUAL" id="MANUAL">
			<td align="right" width="1%"><code><b>MANUAL</b></code></td>
			<td><code><span class="php-num">1</span></code> <a href="#MANUAL" class="anchor">#</a></td>
		</tr>
		<tr data-order="INACTIVITY" id="INACTIVITY">
			<td align="right" width="1%"><code><b>INACTIVITY</b></code></td>
			<td><code><span class="php-num">2</span></code> <a href="#INACTIVITY" class="anchor">#</a></td>
		</tr>
		<tr data-order="BROWSER_CLOSED" id="BROWSER_CLOSED">
			<td align="right" width="1%"><code><b>BROWSER_CLOSED</b></code></td>
			<td><code><span class="php-num">3</span></code> <a href="#BROWSER_CLOSED" class="anchor">#</a></td>
		</tr>
		</table>
	</div>



	<div id="propertySummary">
		<table class="summary">
		<caption>Property Summary</caption>
		<tr data-order="guestRole" id="$guestRole">
			<td align="right" width="1%"><code class="nowrap">
				 
				string
			</code></td>

			<td width="1%"><var>$guestRole</var></td>
			<td><pre><span class="php-quote">'guest'</span></pre></td>
			<td>default role for unauthenticated user <a href="#$guestRole" class="anchor">#</a></td>
		</tr>
		<tr data-order="authenticatedRole" id="$authenticatedRole">
			<td align="right" width="1%"><code class="nowrap">
				 
				string
			</code></td>

			<td width="1%"><var>$authenticatedRole</var></td>
			<td><pre><span class="php-quote">'authenticated'</span></pre></td>
			<td>default role for authenticated user without own identity <a href="#$authenticatedRole" class="anchor">#</a></td>
		</tr>
		<tr data-order="onLoggedIn" id="$onLoggedIn">
			<td align="right" width="1%"><code class="nowrap">
				 
				array
			</code></td>

			<td width="1%"><var>$onLoggedIn</var></td>
			<td><pre><span class="php-keyword1">NULL</span></pre></td>
			<td>of function(User $sender); Occurs when the user is successfully logged in <a href="#$onLoggedIn" class="anchor">#</a></td>
		</tr>
		<tr data-order="onLoggedOut" id="$onLoggedOut">
			<td align="right" width="1%"><code class="nowrap">
				 
				array
			</code></td>

			<td width="1%"><var>$onLoggedOut</var></td>
			<td><pre><span class="php-keyword1">NULL</span></pre></td>
			<td>of function(User $sender); Occurs when the user is logged out <a href="#$onLoggedOut" class="anchor">#</a></td>
		</tr>
		<tr data-order="onAuthenticated" id="$onAuthenticated" class="deprecated">
			<td align="right" width="1%"><code class="nowrap">
				deprecated  
				
			</code></td>

			<td width="1%"><var>$onAuthenticated</var></td>
			<td><pre><span class="php-keyword1">NULL</span></pre></td>
			<td> <a href="#$onAuthenticated" class="anchor">#</a></td>
		</tr>
		<tr data-order="onSignedOut" id="$onSignedOut" class="deprecated">
			<td align="right" width="1%"><code class="nowrap">
				deprecated  
				
			</code></td>

			<td width="1%"><var>$onSignedOut</var></td>
			<td><pre><span class="php-keyword1">NULL</span></pre></td>
			<td> <a href="#$onSignedOut" class="anchor">#</a></td>
		</tr>

		<tr data-order="identity" id="$identity">
			<td align="right" width="1%"><code class="nowrap">
				magic <a href="Nette.Security.IIdentity.html">Nette\Security\IIdentity</a>
			</code></td>

			<td width="1%"><var>$identity</var></td>
			<td></td>
			<td> <a href="#$identity" class="anchor">#</a></td>
		</tr>
		<tr data-order="logoutReason" id="$logoutReason">
			<td align="right" width="1%"><code class="nowrap">
				magic int
			</code></td>

			<td width="1%"><var>$logoutReason</var></td>
			<td></td>
			<td> <a href="#$logoutReason" class="anchor">#</a></td>
		</tr>
		<tr data-order="roles" id="$roles">
			<td align="right" width="1%"><code class="nowrap">
				magic array
			</code></td>

			<td width="1%"><var>$roles</var></td>
			<td></td>
			<td> <a href="#$roles" class="anchor">#</a></td>
		</tr>
		<tr data-order="authenticated" id="$authenticated">
			<td align="right" width="1%"><code class="nowrap">
				magic bool
			</code></td>

			<td width="1%"><var>$authenticated</var></td>
			<td></td>
			<td> <a href="#$authenticated" class="anchor">#</a></td>
		</tr>
		<tr data-order="authenticationHandler" id="$authenticationHandler">
			<td align="right" width="1%"><code class="nowrap">
				magic <a href="Nette.Security.IAuthenticator.html">Nette\Security\IAuthenticator</a>
			</code></td>

			<td width="1%"><var>$authenticationHandler</var></td>
			<td></td>
			<td> <a href="#$authenticationHandler" class="anchor">#</a></td>
		</tr>
		<tr data-order="authorizationHandler" id="$authorizationHandler">
			<td align="right" width="1%"><code class="nowrap">
				magic <a href="Nette.Security.IAuthorizator.html">Nette\Security\IAuthorizator</a>
			</code></td>

			<td width="1%"><var>$authorizationHandler</var></td>
			<td></td>
			<td> <a href="#$authorizationHandler" class="anchor">#</a></td>
		</tr>
		</table>
	</div>


</div>

	<div id="footer">
		Nette Framework API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</body>
</html>
